-
Notifications
You must be signed in to change notification settings - Fork 60.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add alternative to bfg on about-large-files-on-github.md #34635
Conversation
With all due respect, I found BFG really clunky to work with. Hence, I searched for an alternative. Credits to ZelluX (https://stackoverflow.com/a/1186549).
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
Automatically generated comment ℹ️This comment is automatically generated and will be overwritten every time changes are committed to this branch. The table contains an overview of files in the Content directory changesYou may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.
fpt: Free, Pro, Team |
Hi @MathiasBaumgartinger and thanks for your interest in the GitHub docs 👋 I'm afraid we won't be accepting this contribution on this occasion—I'll outline our reasoning below:
For cases like this, where there isn't an immediately straightforward solution, I'd really recommend opening an issue first before taking time to write a PR. That way we can have a discussion first, and everybody involved—most importantly, you—has a better experience. I will pass on feedback to the content team in question for any future updates they may make to this article. Thanks again for your interest in the GitHub docs. |
Hey there! I accidentally got caught in the same trap today again. I really cannot understand why you would recommend BFG for a solution that can honestly be solved in a matter so much simpler. For the sake of all other clumsy fellows out there, I would really appreciate you consider exposing this option in your documentation. |
@MathiasBaumgartinger Thank you for sharing! Would you be able to raise an issue (instead of a PR) in this repo on this topic? We can then have our SMEs review your proposal and gather their feedback on the best path forward 💛 |
Hi, The alternative text suggested here might work great for some users, but it doesn't provide warnings about when it is applicable (only if the history is linear, only if the large files are contained to one branch, and as the instructions are written, only if the large file was only touched in a single commit) which could be very deleterious for other users. See #34950 for more details. Also, as promised there, we do have a pending change that will mention interactive rebase, but with the caveats listed. Docs team: It's a little |
With all due respect, I found BFG really clunky to work with. Hence, I searched for an alternative. Credits to ZelluX (https://stackoverflow.com/a/1186549).
Why:
BFG is a mighty tool, but may have to much overhead for a simple solution concerning big files in a previous commit.
Closes:
What's being changed (if available, include any code snippets, screenshots, or gifs):
Just the documentation on large files and how to handle them in order to be able to push to github.
Check off the following:
I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).
data
directory.For content changes, I have completed the self-review checklist.